<html>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<link rel="stylesheet" href="style.css" type="text/css" media="all" />
<body>
<h1>Функции</h1><ul><li><a href="#cmsSetCookie">cmsSetCookie</a></li><li><a href="#error404">error404</a></li><li><a href="#explayHash">explayHash</a></li><li><a href="#formatDate">formatDate</a></li><li><a href="#getCookie">getCookie</a></li><li><a href="#getNumWithCase">getNumWithCase</a></li><li><a href="#getRequest">getRequest</a></li><li><a href="#getServer">getServer</a></li><li><a href="#getSession">getSession</a></li><li><a href="#lang">lang</a></li><li><a href="#loadLang">loadLang</a></li><li><a href="#redirect">redirect</a></li><li><a href="#safeSql">safeSql</a></li><li><a href="#setSession">setSession</a></li><li><a href="#translit">translit</a></li><li><a href="#userGroup">userGroup</a></li></ul><a name="cmsSetCookie"></a>
<h3>cmsSetCookie</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">void</span> <span class="name">cmsSetCookie</span> (<span class="type">string</span> <span class="varname">$name</span>, <span class="type">mixed</span> <span class="varname">$value</span>, <span class="type">mixed</span> <span class="varname">$lifetime</span> = false)</div><p>Устанавливает значение cookie пользователя</p>
</div>
</div><div class="block parametrs">
<h4>Параметры</h4>
<div class="text parametrs"><dl class="var_description">
	<dt>name</dt>
	<dd>название переменной</dd>
</dl><dl class="var_description">
	<dt>value</dt>
	<dd>значение</dd>
</dl><dl class="var_description">
	<dt>lifetime</dt>
	<dd>время жизни в секундах (по-умолчанию - берется значение из реестра "//settings/site/cookie_lifetime")</dd>
</dl>
</div>
</div><a name="error404"></a>
<h3>error404</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">ModuleResponse</span> <span class="name">error404</span> ()</div><p>Ошибка 404</p>
</div>
</div><a name="explayHash"></a>
<h3>explayHash</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">string</span> <span class="name">explayHash</span> (<span class="type">string</span> <span class="varname">$string</span>)</div><p>Шифрует строку с добавлением секретного ключа сайта</p>
</div>
</div><a name="formatDate"></a>
<h3>formatDate</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">string</span> <span class="name">formatDate</span> (<span class="type">string</span> <span class="varname">$string</span>)</div><p>Функция преобразования времени в удобочитаемый формат</p>
</div>
</div><div class="block parametrs">
<h4>Параметры</h4>
<div class="text parametrs"><dl class="var_description">
	<dt>string</dt>
	<dd>время в формате UNIX</dd>
</dl>
</div>
</div><a name="getCookie"></a>
<h3>getCookie</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">string</span> <span class="name">getCookie</span> (<span class="type">string</span> <span class="varname">$key</span>)</div><p>Возвращает защищенное значение cookie пользователя</p>
</div>
</div><div class="block parametrs">
<h4>Параметры</h4>
<div class="text parametrs"><dl class="var_description">
	<dt>key</dt>
	<dd>название переменной</dd>
</dl>
</div>
</div><a name="getNumWithCase"></a>
<h3>getNumWithCase</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">string</span> <span class="name">getNumWithCase</span> (<span class="type">integer</span> <span class="varname">$cnt</span>, <span class="type">array</span> <span class="varname">$case</span>, <span class="type">boolean</span> <span class="varname">$word</span> = true)</div><p>Функция, возвращающая нужную форму слова в зависимости от значения числа $cnt (определение падежа)</p>
</div>
</div><div class="block parametrs">
<h4>Параметры</h4>
<div class="text parametrs"><dl class="var_description">
	<dt>cnt</dt>
	<dd>число</dd>
</dl><dl class="var_description">
	<dt>case</dt>
	<dd>массив из 3-х элементов - форм зависимого слова</dd>
</dl><dl class="var_description">
	<dt>word</dt>
	<dd>при установке этого параметра в true число равное нулю будет заменяться на слово "нет"</dd>
</dl>
</div>
</div><div class="block samples">
<h4>Примеры</h4><div class="sample">
<p>Пример №1</p>
<div class="sample_content"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #007700">print&nbsp;</span><span style="color: #0000BB">getNumWithCase&nbsp;</span><span style="color: #007700">(</span><span style="color: #0000BB">21</span><span style="color: #007700">,&nbsp;array&nbsp;(</span><span style="color: #DD0000">'слон'</span><span style="color: #007700">,</span><span style="color: #DD0000">'слона'</span><span style="color: #007700">,</span><span style="color: #DD0000">'слонов'</span><span style="color: #007700">));&nbsp;</span><span style="color: #FF8000">//&nbsp;21&nbsp;слон<br /></span><span style="color: #007700">print&nbsp;</span><span style="color: #0000BB">getNumWithCase&nbsp;</span><span style="color: #007700">(</span><span style="color: #0000BB">2</span><span style="color: #007700">,&nbsp;array&nbsp;(</span><span style="color: #DD0000">'слон'</span><span style="color: #007700">,</span><span style="color: #DD0000">'слона'</span><span style="color: #007700">,</span><span style="color: #DD0000">'слонов'</span><span style="color: #007700">));&nbsp;</span><span style="color: #FF8000">//&nbsp;2&nbsp;слона<br /></span><span style="color: #007700">print&nbsp;</span><span style="color: #0000BB">getNumWithCase&nbsp;</span><span style="color: #007700">(</span><span style="color: #0000BB">15</span><span style="color: #007700">,&nbsp;array&nbsp;(</span><span style="color: #DD0000">'слон'</span><span style="color: #007700">,</span><span style="color: #DD0000">'слона'</span><span style="color: #007700">,</span><span style="color: #DD0000">'слонов'</span><span style="color: #007700">));&nbsp;</span><span style="color: #FF8000">//&nbsp;15&nbsp;слонов<br /></span><span style="color: #007700">print&nbsp;</span><span style="color: #0000BB">getNumWithCase&nbsp;</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">,&nbsp;array&nbsp;(</span><span style="color: #DD0000">'слон'</span><span style="color: #007700">,</span><span style="color: #DD0000">'слона'</span><span style="color: #007700">,</span><span style="color: #DD0000">'слонов'</span><span style="color: #007700">));&nbsp;</span><span style="color: #FF8000">//&nbsp;нет&nbsp;слонов<br /></span><span style="color: #007700">print&nbsp;</span><span style="color: #0000BB">getNumWithCase&nbsp;</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">,&nbsp;array&nbsp;(</span><span style="color: #DD0000">'слон'</span><span style="color: #007700">,</span><span style="color: #DD0000">'слона'</span><span style="color: #007700">,</span><span style="color: #DD0000">'слонов'</span><span style="color: #007700">),&nbsp;</span><span style="color: #0000BB">false</span><span style="color: #007700">);&nbsp;</span><span style="color: #FF8000">//&nbsp;0&nbsp;слонов<br /><br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
</div>
</div><a name="getRequest"></a>
<h3>getRequest</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">mixed</span> <span class="name">getRequest</span> (<span class="type">string</span> <span class="varname">$key</span>, <span class="type">string</span> <span class="varname">$type</span> = 's')</div><p>Возвращает защищенное значение переменной из массива $_REQUEST</p>
</div>
</div><div class="block parametrs">
<h4>Параметры</h4>
<div class="text parametrs"><dl class="var_description">
	<dt>key</dt>
	<dd>ключ переменной</dd>
</dl><dl class="var_description">
	<dt>type</dt>
	<dd>тип ожидаемого значения: s - строка, i - целое число, f - число с плавающей точкой, b - булевое выражение</dd>
</dl>
</div>
</div><a name="getServer"></a>
<h3>getServer</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">string</span> <span class="name">getServer</span> (<span class="type">string</span> <span class="varname">$key</span>)</div><p>Возвращает значение переменной из массива $_SERVER</p>
</div>
</div><div class="block parametrs">
<h4>Параметры</h4>
<div class="text parametrs"><dl class="var_description">
	<dt>key</dt>
	<dd>ключ переменной</dd>
</dl>
</div>
</div><a name="getSession"></a>
<h3>getSession</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">string</span> <span class="name">getSession</span> (<span class="type">string</span> <span class="varname">$key</span>)</div><p>Возвращает значение переменной сессии пользователя</p>
</div>
</div><div class="block parametrs">
<h4>Параметры</h4>
<div class="text parametrs"><dl class="var_description">
	<dt>key</dt>
	<dd>имя переменной</dd>
</dl>
</div>
</div><a name="lang"></a>
<h3>lang</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">string</span> <span class="name">lang</span> (<span class="type">string</span> <span class="varname">$label</span>, <span class="type">string</span> <span class="varname">$key</span>)</div><p>Возвращает значение языковой переменной с ключем $label в подмассиве $key</p>
</div>
</div><div class="block parametrs">
<h4>Параметры</h4>
<div class="text parametrs"><dl class="var_description">
	<dt>label</dt>
	<dd>ключ переменной</dd>
</dl><dl class="var_description">
	<dt>key</dt>
	<dd>ключ подмассива (название модуля и т.п.)</dd>
</dl>
</div>
</div><a name="loadLang"></a>
<h3>loadLang</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">void</span> <span class="name">loadLang</span> (<span class="type">string</span> <span class="varname">$langFile</span>, <span class="type">string</span> <span class="varname">$key</span>)</div><p>Подгружает массив с языковыми переменными из указанного файла в заданный подмассив</p>
</div>
</div><div class="block parametrs">
<h4>Параметры</h4>
<div class="text parametrs"><dl class="var_description">
	<dt>langFile</dt>
	<dd>полный путь до файла</dd>
</dl><dl class="var_description">
	<dt>key</dt>
	<dd>ключ подмассива (название модуля и т.п.)</dd>
</dl>
</div>
</div><a name="redirect"></a>
<h3>redirect</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">void</span> <span class="name">redirect</span> (<span class="type">string</span> <span class="varname">$uri</span>)</div><p>Перенаправляет пользователя на заданный URI</p>
</div>
</div><a name="safeSql"></a>
<h3>safeSql</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">string</span> <span class="name">safeSql</span> (<span class="type">string</span> <span class="varname">$s</span>)</div><p>Возвращает защищенную от mysql-иньекций строку</p>
</div>
</div><a name="setSession"></a>
<h3>setSession</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">void</span> <span class="name">setSession</span> (<span class="type">string</span> <span class="varname">$name</span>, <span class="type">mixed</span> <span class="varname">$value</span>)</div><p>Устанавливает значение переменной сессии пользователя</p>
</div>
</div><div class="block parametrs">
<h4>Параметры</h4>
<div class="text parametrs"><dl class="var_description">
	<dt>name</dt>
	<dd>имя переменной</dd>
</dl><dl class="var_description">
	<dt>value</dt>
	<dd>значение</dd>
</dl>
</div>
</div><a name="translit"></a>
<h3>translit</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">string</span> <span class="name">translit</span> (<span class="type">string</span> <span class="varname">$string</span>)</div><p>Преобразует символы строки в нижний регистр, заменяет русские буквы на созвучные латинские и экранирует/заменяет некоторые знаки препинания</p>
</div>
</div><a name="userGroup"></a>
<h3>userGroup</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">string</span> <span class="name">userGroup</span> (<span class="type">integer</span> <span class="varname">$num</span>)</div><p>Возвращает латинское название группы пользователя</p>
</div>
</div><div class="block parametrs">
<h4>Параметры</h4>
<div class="text parametrs"><dl class="var_description">
	<dt>num</dt>
	<dd>номер группы</dd>
</dl>
</div>
</div></body>
</html>